'\" t
.TH "SD_JOURNAL_GET_DATA" "3" "" "systemd 256.7" "sd_journal_get_data"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sd_journal_get_data, sd_journal_enumerate_data, sd_journal_enumerate_available_data, sd_journal_restart_data, SD_JOURNAL_FOREACH_DATA, sd_journal_set_data_threshold, sd_journal_get_data_threshold \- Read data fields from the current journal entry
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-journal\&.h>
.fi
.ft
.HP \w'int\ sd_journal_get_data('u
.BI "int sd_journal_get_data(sd_journal\ *" "j" ", const\ char\ *" "field" ", const\ void\ **" "data" ", size_t\ *" "length" ");"
.HP \w'int\ sd_journal_enumerate_data('u
.BI "int sd_journal_enumerate_data(sd_journal\ *" "j" ", const\ void\ **" "data" ", size_t\ *" "length" ");"
.HP \w'int\ sd_journal_enumerate_available_data('u
.BI "int sd_journal_enumerate_available_data(sd_journal\ *" "j" ", const\ void\ **" "data" ", size_t\ *" "length" ");"
.HP \w'void\ sd_journal_restart_data('u
.BI "void sd_journal_restart_data(sd_journal\ *" "j" ");"
.HP \w'SD_JOURNAL_FOREACH_DATA('u
.BI "SD_JOURNAL_FOREACH_DATA(sd_journal\ *" "j" ", const\ void\ *" "data" ", size_t\ " "length" ");"
.HP \w'int\ sd_journal_set_data_threshold('u
.BI "int sd_journal_set_data_threshold(sd_journal\ *" "j" ", size_t\ " "sz" ");"
.HP \w'int\ sd_journal_get_data_threshold('u
.BI "int sd_journal_get_data_threshold(sd_journal\ *" "j" ", size_t\ *" "sz" ");"
.SH "DESCRIPTION"
.PP
\fBsd_journal_get_data()\fR
gets the data object associated with a specific field from the current journal entry\&. It takes four arguments: the journal context object, a string with the field name to request, plus a pair of pointers to pointer/size variables where the data object and its size shall be stored in\&. The field name should be an entry field name\&. Well\-known field names are listed in
\fBsystemd.journal-fields\fR(7), but any field can be specified\&. The returned data is in a read\-only memory map and is only valid until the next invocation of
\fBsd_journal_get_data()\fR,
\fBsd_journal_enumerate_data()\fR,
\fBsd_journal_enumerate_available_data()\fR, or when the read pointer is altered\&. Note that the data returned will be prefixed with the field name and
"="\&. Also note that, by default, data fields larger than 64K might get truncated to 64K\&. This threshold may be changed and turned off with
\fBsd_journal_set_data_threshold()\fR
(see below)\&.
.PP
\fBsd_journal_enumerate_data()\fR
may be used to iterate through all fields of the current entry\&. On each invocation the data for the next field is returned\&. The order of these fields is not defined\&. The data returned is in the same format as with
\fBsd_journal_get_data()\fR
and also follows the same life\-time semantics\&.
.PP
\fBsd_journal_enumerate_available_data()\fR
is similar to
\fBsd_journal_enumerate_data()\fR, but silently skips any fields which may be valid, but are too large or not supported by current implementation\&.
.PP
\fBsd_journal_restart_data()\fR
resets the data enumeration index to the beginning of the entry\&. The next invocation of
\fBsd_journal_enumerate_data()\fR
will return the first field of the entry again\&.
.PP
Note that the
\fBSD_JOURNAL_FOREACH_DATA()\fR
macro may be used as a handy wrapper around
\fBsd_journal_restart_data()\fR
and
\fBsd_journal_enumerate_available_data()\fR\&.
.PP
Note that these functions will not work before
\fBsd_journal_next\fR(3)
(or related call) has been called at least once, in order to position the read pointer at a valid entry\&.
.PP
\fBsd_journal_set_data_threshold()\fR
may be used to change the data field size threshold for data returned by
\fBsd_journal_get_data()\fR,
\fBsd_journal_enumerate_data()\fR
and
\fBsd_journal_enumerate_unique()\fR\&. This threshold is a hint only: it indicates that the client program is interested only in the initial parts of the data fields, up to the threshold in size \(em but the library might still return larger data objects\&. That means applications should not rely exclusively on this setting to limit the size of the data fields returned, but need to apply an explicit size limit on the returned data as well\&. This threshold defaults to 64K by default\&. To retrieve the complete data fields this threshold should be turned off by setting it to 0, so that the library always returns the complete data objects\&. It is recommended to set this threshold as low as possible since this relieves the library from having to decompress large compressed data objects in full\&.
.PP
\fBsd_journal_get_data_threshold()\fR
returns the currently configured data field size threshold\&.
.SH "RETURN VALUE"
.PP
\fBsd_journal_get_data()\fR
returns 0 on success or a negative errno\-style error code\&.
\fBsd_journal_enumerate_data()\fR
and
\fBsd_journal_enumerate_available_data()\fR
return a positive integer if the next field has been read, 0 when no more fields remain, or a negative errno\-style error code\&.
\fBsd_journal_restart_data()\fR
doesn\*(Aqt return anything\&.
\fBsd_journal_set_data_threshold()\fR
and
\fBsd_journal_get_threshold()\fR
return 0 on success or a negative errno\-style error code\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-EINVAL\fR
.RS 4
One of the required parameters is
\fBNULL\fR
or invalid\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ECHILD\fR
.RS 4
The journal object was created in a different process, library or module instance\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-EADDRNOTAVAIL\fR
.RS 4
The read pointer is not positioned at a valid entry;
\fBsd_journal_next\fR(3)
or a related call has not been called at least once\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENOENT\fR
.RS 4
The current entry does not include the specified field\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENOMEM\fR
.RS 4
Memory allocation failed\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-ENOBUFS\fR
.RS 4
A compressed entry is too large\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-E2BIG\fR
.RS 4
The data field is too large for this computer architecture (e\&.g\&. above 4 GB on a 32\-bit architecture)\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-EPROTONOSUPPORT\fR
.RS 4
The journal is compressed with an unsupported method or the journal uses an unsupported feature\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-EBADMSG\fR
.RS 4
The journal is corrupted (possibly just the entry being iterated over)\&.
.sp
Added in version 246\&.
.RE
.PP
\fB\-EIO\fR
.RS 4
An I/O error was reported by the kernel\&.
.sp
Added in version 246\&.
.RE
.SH "NOTES"
.PP
All functions listed here are thread\-agnostic and only a single specific thread may operate on a given object during its entire lifetime\&. It\*(Aqs safe to allocate multiple independent objects and use each from a specific thread in parallel\&. However, it\*(Aqs not safe to allocate such an object in one thread, and operate or free it from any other, even if locking is used to ensure these threads don\*(Aqt operate on it at the very same time\&.
.PP
Functions described here are available as a shared library, which can be compiled against and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.SH "EXAMPLES"
.PP
See
\fBsd_journal_next\fR(3)
for a complete example how to use
\fBsd_journal_get_data()\fR\&.
.PP
Use the
\fBSD_JOURNAL_FOREACH_DATA()\fR
macro to iterate through all fields of the current journal entry:
.sp
.if n \{\
.RS 4
.\}
.nf
\&...
int print_fields(sd_journal *j) {
  const void *data;
  size_t length;
  SD_JOURNAL_FOREACH_DATA(j, data, length)
    printf("%\&.*s\en", (int) length, data);
}
\&...
.fi
.if n \{\
.RE
.\}
.SH "HISTORY"
.PP
\fBsd_journal_get_data()\fR,
\fBsd_journal_enumerate_data()\fR,
\fBsd_journal_restart_data()\fR, and
\fBSD_JOURNAL_FOREACH_DATA()\fR
were added in version 187\&.
.PP
\fBsd_journal_set_data_threshold()\fR
and
\fBsd_journal_get_data_threshold()\fR
were added in version 196\&.
.PP
\fBsd_journal_enumerate_available_data()\fR
was added in version 246\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1), \fBsystemd.journal-fields\fR(7), \fBsd-journal\fR(3), \fBsd_journal_open\fR(3), \fBsd_journal_next\fR(3), \fBsd_journal_get_realtime_usec\fR(3), \fBsd_journal_query_unique\fR(3)
